Skip to main content

Add User

Description

Google Workspace: Add User step, creates users on Google Workspace.

Configurations

No.Field NameDescription
1Step nameName of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
Connection
2Client IDSpecify Client ID of the Google application.
The data type is String. This field is mandatory.
Client Secret
3Accept Values from fieldsLeave checkbox unchecked to accept Client Secret value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Secret Key field to appear as Text box.
4Client SecretSpecify Client Secret of the Google application.
If checkbox above is enabled Client Secret field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Client Secret field appears as a drop down containing values from previous steps - to select from.
The data type is String. This field is mandatory.
Refresh Token
5Accept Values from fieldsLeave checkbox unchecked to accept Secret Key value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Secret Key field to appear as Text box.
6Refresh TokenSpecify a Refresh Token to obtain a new Access Token.
Note:Refresh Token expires if idle for 6 months.
If checkbox above is enabled Refresh Token field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Refresh Token field appears as a drop down containing values from previous steps - to select from.
The data type is String. This field is mandatory.
7Button: Test ConnectionVerifies whether the connection is established or not.
Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state; only static values and environment variables are allowed.
Input Fields
1First NameSelect the first name of the user.
The data type is String. This field is mandatory.
2SurnameSelect the surname of the user.
The data type is String. This field is mandatory.
3Primary EmailSelect the username for the primary email.
The data type is String. This field is mandatory.
4DomainSelect the domain for the primary email.
The data type is String. This field is mandatory.
Button: GetClick to get the list of the available domain under the Google Workspace admin account.
5PasswordSelect the new password for user.
The data type is String. This field is mandatory.
6Ask User To Change Their Password When They Sign InSelect Yes or No.
If you select Yes, users must change the password when they sign on again to the Google Workspace. If you select No, then users do not need to change their password.
Additional Input Fields
1Full NameSelect the user’s full name.
2Secondary EmailSelect the secondary or the recovery email address of the user.
3Phone NumberSelect the recovery phone number of the user with the country code.
4Organizational Unit PathSelect the organizational unit or path to sub-organizational units.
Note:You can simply use “/” to denote root of the organizational unit or the path to sub organizational units.
5Include In Global Address ListSelect Yes or No.
If you select Yes, include user to the global address list. However, if you select No, user will not be added to the global address list.
Default value: No
6IP WhitelistedSelect Yes or No.
If you select Yes, whitelist the IP of the user. However, if you select No, if you do not want to whitelist the IP of the user.
Default value: No
7SuspendedSelect Yes or No. If you select Yes, the user is suspended.
Default value: No
Contact Information Fields
1Field NameSelect the field name to display user information.
Available values are: Email, Phone, and Address.
2TypeSelect the type for the respective field name.
Available values for Email: Home, Work, Custom, and Other.
Available values for Phone: Home, Work, and Mobile.
Available values for Address: Home, Work, and Other.
3ValueSelect the Value with respect to the selected field name and the type.
Employee Information Fields
1Static Field NameSelect a static field name.
Available values are: Employee ID, Job Title, Type of employee, Manager's Email, Department, Cost centre, Building ID, Floor name, and Floor section.
2Variable Field NameSelect a variable field name.
Available values are: Employee ID, Job Title, Type of employee, Manager's Email, Department, Cost centre, Building ID, Floor name, and Floor section.
3ValueSpecify the value with respect to the selected Field Name.
Output Fields
1Unique User IDSpecify the user’s unique ID.
Default is: User’s unique ID